fix(docs): tutorial source-plugin -> fix code block language, add title #24579
Conversation
gatsbot
bot
added
the
status: triage needed
pieh
added
status: needs docs review
| @@ -110,7 +110,7 @@ _You can include the plugin by using its name if you are using [npm link or yarn | |||
|
|
|||
| You can now navigate into the `example-site` folder and run `gatsby develop`. You should see a line in the output in the terminal that shows your plugin loaded: | |||
|
|
|||
| ```shell | |||
| ```shell:title=example-site | |||
There was a problem hiding this comment.
I wonder if this can be done for every shell command on the Gatsby website? I think not. I would rather leave a shell tag without a title because the text before it implies running it in the example-site directory.
| ```shell:title=example-site | |
| ```shell |
There was a problem hiding this comment.
if you look into the full tutorial text: the shell commands in this tutorial use this title to mark the directory if it is in a subdirectory - only this 2 places was not.
to be consistent in one doc there are 2 solutions:
- remove it from the other
shell, or - add it here.
i would add it here because that helps a little the reader - i liked here that also the js code examples had the subdirs are in the title :)
There was a problem hiding this comment.
I think kyle was trying to be more specific because it wasn't implied in the two places the :title=example-site tag was used with shell. The other 4 places were implied.
There was a problem hiding this comment.
gatsby/docs/tutorial/source-plugin-tutorial.md
Lines 437 to 439 in 2630758
gatsby/docs/tutorial/source-plugin-tutorial.md
Lines 532 to 534 in 2630758
in the other 2 cases it is noted also the line before.
but i think, more easy for the reader is if he reads a second time in the title in which directory he should execute the commands...
| @@ -200,7 +200,7 @@ You can query data from any location to source at build time using functions and | |||
|
|
|||
| You'll use several modules from npm to making fetching data with GraphQL easier. Install them in the `source-plugin` project with: | |||
|
|
|||
| ```shell | |||
| ```shell:title=source-plugin | |||
There was a problem hiding this comment.
| ```shell:title=source-plugin | |
| ```shell |
| @@ -642,7 +642,7 @@ Add a file at `example-site/src/pages/index.js` and copy the following code into | |||
|
|
|||
| Ensure you have `gatsby-image` installed in the site by running `npm install gatsby-image`. It provides a component that can take the optimized image data and render it. | |||
|
|
|||
| ```javascript:title=example-site/src/pages/index.js | |||
| ```jsx:title=example-site/src/pages/index.js | |||
muescha
deleted the
muescha/fix/tutorial-source-plugin-code-block-language
branch
Description
changes:
Related Issues
docs: new source plugin tutorial